Vcenter NamespaceManagement LoadBalancers Info

Vcenter NamespaceManagement LoadBalancers Info
Vcenter NamespaceManagement LoadBalancers Info

The Vcenter NamespaceManagement LoadBalancers Info contains information related to the load balancer for provisioning virtual servers in the namespace.

This schema was added in vSphere API 7.0.1.0.

JSON Example
{
    "id": "string",
    "address_ranges": [
        {
            "address": "string",
            "count": 0
        }
    ],
    "provider": "string",
    "ha_proxy_info": {
        "servers": [
            {
                "host": "string",
                "port": 0
            }
        ],
        "username": "string",
        "certificate_authority_chain": "string"
    },
    "avi_info": {
        "server": {
            "host": "string",
            "port": 0
        },
        "username": "string",
        "certificate_authority_chain": "string",
        "cloud_name": "string"
    }
}
string
id
Required

An DNS compliant identifier for a load balancer, which can be used to query or configure the load balancer properties.

This property was added in vSphere API 7.0.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.

array of Vcenter NamespaceManagement IPRange
address_ranges
Required

IP address range from which virtual servers are assigned their IPs.

This property was added in vSphere API 7.0.1.0.

string
provider
Required

Load balancer provider for the namespace.

For more information see: Vcenter NamespaceManagement LoadBalancers Provider.

This property was added in vSphere API 7.0.1.0.

ha_proxy_info
Optional

This property is deprecated as of vSphere API 9.0.0.0. Instead, use Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerInfo with provider Vcenter NamespaceManagement Networks Edges EdgeProvider.VSPHERE_FOUNDATION.

The Vcenter NamespaceManagement LoadBalancers HAProxyInfo is a conditional configuration made available upon selecting the HA_PROXY load balancer provider. It is used to configure the load balancer at run time.

This property was added in vSphere API 7.0.1.0.

This property is optional and it is only relevant when the value of provider is Vcenter NamespaceManagement LoadBalancers Provider.HA_PROXY.

avi_info
Optional

The Vcenter NamespaceManagement LoadBalancers AviInfo is a conditional configuration made available upon selecting the Avi load balancer provider. It is used to configure the load balancer at run time.

This property was added in vSphere API 7.0.2.0.

This property is optional and it is only relevant when the value of provider is Vcenter NamespaceManagement LoadBalancers Provider.AVI.

Property Of
Returned By